home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sfroctrv.zip / SFROCTRV.DOC < prev    next >
Text File  |  1990-06-11  |  17KB  |  396 lines

  1.                                  
  2.                                SFROCTRV
  3.                               Version 2.0
  4.                                    by
  5.                            Michael D. Peters
  6.  
  7.                                                              
  8.     
  9.     
  10.    INTRODUCTION
  11.    ------------
  12.                          
  13.       SFROCTRV is a fast paced Rock & Roll Trivia game designed to run
  14.    as a door feature within the SPITFIRE Bulletin Board System.  It can
  15.    also be installed as a sysop configurable command from the Main, File
  16.    or Message menus of SPITFIRE.  A data file containing 355 Rock & Roll
  17.    Trivia questions is randomly accessed and displayed to the screen.
  18.    With each question that is displayed, four multiple choice options 
  19.    are provided from which the player may select.  SFROCTRV allows the
  20.    player ten seconds to read the question and respond with the number 
  21.    corresponding to the answer they wish to select.
  22.     
  23.     
  24.    SFROCTRV SETUP AS A SPITFIRE DOOR
  25.    ---------------------------------
  26.     
  27.       To set up SFROCTRV to be executed as a door, it is recommended that
  28.    a separate directory be set up for it.  For explanation purposes, let's
  29.    assume the directory DOORA is created for use with SFROCTRV.  The following
  30.    files must then be placed in the directory:
  31.    
  32.    SFROCTRV.EXE    The actual game program.
  33.    
  34.    SFROCTRV.DAT    The data file containing the trivia questions.
  35.    
  36.    SFROCTRV.TOP    This is a listing of the top ten players. SFROCTRV.EXE
  37.                    will create this file if it is not found. 
  38.    
  39.    The Sysop will then need to use a text editor to edit the SF.BAT file   
  40.    as illustrated below:
  41.    
  42.    :DOOR_A
  43.    COPY SFDOORS.DAT C:\SF\DOORA
  44.    SFROCTRV
  45.    ERASE SFDOORS.DAT
  46.    GOTO LOOP
  47.    :DOOR_B
  48.      
  49.    You will notice that the commands needed to execute SFROCTRV are placed
  50.    between the :DOOR_A and GOTO LOOP command lines.  These are entered in
  51.    place of the existing REM Place Program Name Here.  The following will 
  52.    briefly explain each of the commands which were set up within SF.BAT to 
  53.    run SFROCTRV as a SPITFIRE Door program:
  54.    
  55.       SFDOORS.DAT is created automatically by SPITFIRE when a user enters a
  56.    door.  It contains information about the user such as name and password.
  57.    SFROCTRV requires access to the information within SFDOORS.DAT.  Therefore,
  58.    before executing the program it must be copied to the directory in which
  59.    SFROCTRV is running.
  60.    
  61.       SFROCTRV is the program name and executes the game program from within
  62.    the door program.
  63.    
  64.       Once the user has terminated the game play of SFROCTRV the SF.BAT file
  65.    erases the SFDOORS.DAT file.
  66.    
  67.    
  68.    
  69.    SFROCTRV SETUP AS A SYSOP CONFIGURABLE COMMAND
  70.    ----------------------------------------------
  71.  
  72.       SPITFIRE has a sysop configurable command for the Main, Message and
  73.    File menus.  The sysop configurable command is executed through a
  74.    batch file which corresponds to the menu it is being run from.  In
  75.    other words, SFMAIN.BAT runs the sysop configurable command from
  76.    the Main Menu, SFMESS.BAT runs the one from the Message Menu and
  77.    SFFILE.BAT the one from the File Menu.  The commands necessary
  78.    to execute SFROCTRV can be set up in the batch file which corresponds
  79.    to the menu you wish to have SFROCTRV run from.
  80.  
  81.       The first thing you will need to establish is which of these menus
  82.    you wish to use to run SFROCTRV.  For this purpose, let's assume that
  83.    it is going to be set up so it can be run from the Main Menu.  (It
  84.    should be noted the set up procedure is the same regardless of which
  85.    Menu you are running SFROCTRV from.)
  86.  
  87.       Next, you will need to decide what you wish to name the command
  88.    option and establish what security level will be required for
  89.    users of your system to be able to access this option.  Once this
  90.    is determined you will need to modify the SFMAIN.MNU file using
  91.    your favorite text editor, as long as it saves in ASCII format.
  92.    (Refer to the SPITFIRE manual for further documentation on this
  93.    if needed.  It should also be noted that if SFROCTRV were being
  94.    set up to run from the File Menu, you would need to modify the
  95.    SFFILE.MNU file and if it was being set up to be run from the
  96.    Message Menu you would need to modify the SFMSG.MNU file.)
  97.  
  98.  
  99.       Examining the default SFMAIN.MNU file, you will notice the sysop
  100.    configurable command appears as:
  101.  
  102.         <K>............. Add Your Own,,1000,@
  103.  
  104.  
  105.       This will need to be replaced with a Command Character that will
  106.    be used to select the option from the menu.  It is ASOLUTELY IMPERATIVE
  107.    that the Command Character must not duplicate an existing Command
  108.    Character for another menu option.  You will then need to include
  109.    a brief description of the Wildcat door program you are running, two
  110.    commas, the security level required to access this feature, and another
  111.    comma followed by the a @.  The @ must not be changed! (For more detailed
  112.    information on modifying your SFMAIN.MNU, SFMSG.MNU or SFFILE.MNU refer
  113.    to your SPITFIRE manual.)
  114.     
  115.        <K>.... Brief Program Description,,10,@
  116.  
  117.  
  118.       Now you will need to modify the corresponding batch file, SFMAIN.BAT,
  119.    so that it can be executed from the Main Menu.  Do this using your
  120.    favorite text editor, as long as it saves in ASCII format.  (Again, it
  121.    should be noted that if SFROCTRV were being set up to run from the File
  122.    Menu, you would need to modify the SFFILE.BAT file and if it was being
  123.    set up to be run from the Message Menu you would need to modify the
  124.    SFMESS.BAT file.)
  125.  
  126.       Place the SFROCTRV.EXE file in the directory you wish to run the
  127.    program from.  SFROCTRV will create its own player score file,
  128.    SFROCTRV.TOP, if does not already exist.
  129.  
  130.       The commands set up in the SFMAIN.BAT file are very similar to
  131.    those used for executing the game through a door in the SF.BAT file.
  132.    For instance, if you were running SFROCTRV from the main SPITFIRE
  133.    directory your SFMAIN.BAT file might look like this:
  134.  
  135.        ECHO OFF
  136.        BRK OFF
  137.        SFROCTRV
  138.        BRK ON
  139.  
  140.       (BRK is not included in the SPITFIRE package because it is written
  141.    and copyrighted by Solid Systems, 1985, but can be downloaded from
  142.    The Mother Board BBS and Buffalo Creek's BBS as well as a number of 
  143.    other BBS systems.  BRK is not required to run SFROCTRV, however, it
  144.    is recommended since it will prevent a user using the CTRL BRK command 
  145.    to terminate the batch file, gaining access to your system at the 
  146.    DOS level.)
  147.  
  148.       If you wish to set SFROCTRV up in a separate subdirectory from
  149.    SPITFIRE, for instance, a subdirectory named SFROCTRV, your batch
  150.    file might look like this.
  151.  
  152.        ECHO OFF
  153.        BRK OFF
  154.        COPY SFMAIN.DAT \SF\SFROCTRV
  155.        CD \SF\SFROCTRV
  156.        SFROCTRV
  157.        ERASE SFMAIN.DAT
  158.        CD \SF
  159.        BRK ON
  160.  
  161.  
  162.       When SFROCTRV is executed, from either the door with the SF.BAT file
  163.    or from the sysop configurable command through a menu with the
  164.    corresponding batch file, it will first look for the SFMAIN.DAT file,
  165.    then the SFMESS.DAT file, then the SFFILE.DAT file and lastly the
  166.    SFDOORS.DAT file.  It will look for each of these files until it finds
  167.    it and the commands required for its execution.  If none of these
  168.    files are found, SFROCTRV will halt its execution.
  169.    
  170.    
  171.  
  172.    LOCAL PLAY OF SFROCTRV
  173.    ---------------------
  174.  
  175.       It should also be noted that a Sysop can play SFROCTRV locally by
  176.    entering the following command at the DOS prompt:
  177.    
  178.    C:> SFROCTRV /L
  179.  
  180.  
  181.    DTE LOCK FEATURE
  182.    ----------------
  183.    
  184.  
  185.       SFROCTRV automatically detects if the DTE is locked at 19200 baud.  If
  186.    SFROCTRV detects that the DTE is locked, then SFROCTRV opens the serial
  187.    port to the maximum baud rate of your system.  If SFROCTRV does not
  188.    detect that the DTE is locked, then the serial port is opened to the
  189.    baud rate of the caller.
  190.  
  191.    
  192.    SFROCTRV ON A MULTI-NODE SYSTEM
  193.    ------------------------------
  194.    
  195.       SFROCTRV is fully compatible for operation on a multi-node BBS.
  196.    It automatically handles any file locking and file sharing 
  197.    required during the doors execution.   
  198.    
  199.  
  200.    SYSOP FEATURES
  201.    --------------
  202.    
  203.       This door program contains several features which give the sysop 
  204.    control over the door game play on their BBS system.  First, a status 
  205.    line is displayed on the BBS monitor that provides information in 
  206.    regard to the caller's name, baud rate of the caller and the security 
  207.    level of the caller.     
  208.    
  209.       A SFROCTRV.LMT file allows the sysop to establish a time limit for 
  210.    door play according to the security level the caller has on the system.  
  211.    To modify the accompanying SFROCTRV.LMT file, use your favorite text 
  212.    editor to represent the various security levels you have available on 
  213.    your system, a comma then the corresponding time you wish to allow for 
  214.    that particular security level in minutes.  For instance, it might look 
  215.    like this:
  216.    
  217.    10,15
  218.    25,20
  219.    50,25
  220.    999,30
  221.    
  222.    Each security level should begin a new line and you should have a
  223.    setting for each security level you have available on your system.
  224.    If you do not have a time limit set for a particular security 
  225.    SFROCTRV will default to the level 10 security level setting.
  226.    
  227.       Pressing the Shift Key and the F1 key simultaneously will 
  228.    terminate game play of SFROCTRV and return the caller back to the
  229.    BBS.  Pressing the Shift Key and the F9 key simultaneously will
  230.    terminate game play of SFROCTRV and log the caller off of the BBS.
  231.    If the Shift Key and the F9 key are pressed together, logging the
  232.    caller off the BBS, SPITFIRE will recycle and return to the
  233.    SPITFIRE Ready For Caller Prompt.   
  234.             
  235.  
  236.    SFROCTRV EXECUTION
  237.    -----------------
  238.       
  239.    When first executed, SFROCTRV will display a list of the Top Ten high
  240.    score players and the percentage of correct responses they acheived
  241.    while playing SFROCTRV.  Initially, this will be a dummy listing with
  242.    ten lines that display:
  243.    
  244.       0%...............YOUR NAME COULD BE HERE
  245.       
  246.    However, as the game is played, this will fill with the name of the
  247.    players and their percentage ratings.  
  248.    
  249.    NOTE: At least twenty questions must be attempted before SFROCTRV will
  250.          will figure the percentage rating for the player.
  251.          
  252.    To keep things interesting...the Sysop can erase the file which contains
  253.    the top ten listings SFROCTRV.TOP on a routine basis to give additional
  254.    players a chance to have their name added to the list.
  255.    
  256.    As the top ten list is displayed, at the bottom of the screen  is a
  257.    question which prompts the user whether they want to have ANSI Graphics
  258.    (y/n)? available to them during game play.  If the user responds with a
  259.    y (for yes) the game will display in color and if the user responds with
  260.    a n (for no) the game will display in monochrome.
  261.    
  262.    
  263.   
  264.    PLAYING SFROCTRV
  265.    -----------------
  266.   
  267.       Immediately after pressing any key (other than <Q> for Quit) from 
  268.    the Top Ten listing the game screen is displayed.  The screen will
  269.    look like the following:
  270.       
  271.    ------------------------------------------------------------------------
  272.    
  273.    ╔═════════════════════════════════════════════╗
  274.    ║   >>>>>>>>> ROCK & ROLL TRIVIA! <<<<<<<<<   ║
  275.    ║                Version 2.0                  ║
  276.    ║    Rock & Roll Trivia Door For SPITFIRE!    ║
  277.    ║    "The Wild Side" BBS! * (504) 785-6948    ║
  278.    ║ In Cooperation with Buffalo Creek Softtware ║
  279.    ║  Copyright (C) by Michael Peters, 1989,90   ║
  280.    ║       UNREGISTERED SHAREWARE VERSION!       ║
  281.    ╚═════════════════════════════════════════════╝   
  282.        
  283.    RIGHT: 0                        WRONG: 0
  284.     
  285.    QUESTION:
  286.    The Rock & Roll trivia question will be displayed
  287.    here.
  288.     
  289.    <1> Choice 1                        <2> Choice 2
  290.    <3> Choice 3                        <4> Choice 4
  291.     
  292.              Enter Answer: [ 1 2 3 4 <Q>uit]?
  293.                        
  294.    -----------------------------------------------------------------------
  295.    
  296.    The first randomly choosen trivia question is selected from the data
  297.    file and is displayed to the screen. 
  298.    
  299.       The player makes his selection by entering the corresponding number.
  300.    As the game progresses, SFROCTRV will provide a running total of the
  301.    correct answers and also of the wrong answers the user has selected
  302.    during the game play.
  303.  
  304.    If the ten second timer should elapse before you respond, SFROCTRV
  305.    will count this as a wrong response and add an incorrect answer to 
  306.    the total WRONG answers obtained so far.
  307.            
  308.  
  309.    EXITING PLAY
  310.    ------------
  311.    
  312.       When you are ready to exit the game, simply select press "Q" for
  313.    <Q>uit.  If you qualify as one of the top ten players to date, 
  314.    SFROCTRV will congratulate you for becoming one of the top ten scorers
  315.    and add your name to the Top Ten listing.  You will once again see the 
  316.    Top Ten list displayed with your name added to the list.  
  317.    
  318.      If you exit the game before you have completed the twenty
  319.    questions required for eligibility to the Top Ten list or if you do not
  320.    qualify as a Top Ten player, the Top Ten listing will be displayed and 
  321.    you will be prompted to press any key to return to SPITFIRE.
  322.    
  323.    
  324.    DISTRIBUTION
  325.    ------------
  326.      
  327.       Please feel free to share SFROCTRV.ZIP with others.  However, it must
  328.    be distributed with SFROCTRV.EXE, SFROCTRV.DAT, SFROCTRV.TOP and the
  329.    SFROCTRV.DOC in the SFROCTRV.ZIP distribution package.  These files must
  330.    not be altered in any way or by any means.
  331.    
  332.          SFROCTRV.ZIP is distributed as Shareware software.  You are free to
  333.    try SFROCTRV, and if you find it to be a program you use please send the
  334.    required $10.00 fee to:
  335.    
  336.                              Michael Peters
  337.                              P. O. Box 822
  338.                              Luling, LA. 70070
  339.                              
  340.    DISCLAIMER
  341.    ----------
  342.    
  343.       Michael Peters shall not be held responsible for any damage incurred
  344.    by the user to hardware, software, or peripheral devices while running
  345.    SFROCTRV.  All responsibility lies in the user of the software.
  346.    
  347.    
  348.       Many thanks are indeed owed to Mike Woltz of Buffalo Creek BBS (515)-
  349.    225-8496 for his assistance.  Without his help this program would not
  350.    have been possible.   
  351.    
  352.  
  353.    SFROCTRV and other SPITFIRE programs are available for download from:
  354.    
  355.         Buffalo Creek BBS                     The Mother Board BBS
  356.         Sysop - Mike Woltz                   Sysop - Jacque Shipley
  357.           (515) 225-8496                         (515) 986-3445
  358.        19200/9600/2400/1200                      9800/2400/1200
  359.  
  360.                             The Wild Side BBS
  361.                            Sysop - Mike Peters
  362.                              (504)  785-6948
  363.                               2400/1200/300
  364.  
  365.    Credits:
  366.    --------
  367.  
  368.       I would like to thank a number of people who have helped with the
  369.    release of this version of Rock & Roll Trivia. First and foremost is
  370.    Dan Payne, who is responsible for the majority of the questions in
  371.    this version. Due to other responsibilities requiring his attention,
  372.    Dan was unable to continue his support of Rock & Roll Trivia, and he
  373.    has agreed to allow the use of the questions from the previous version
  374.    to be used here. Call Dan's BBS - The User Surly Board - (515) 989-4486
  375.    to check out other software available from him.
  376.  
  377.       I would also like to thank a couple of friends who spent quite a few
  378.    hours with me while we tried to come up with new questions for this
  379.    version of Rock & Roll Trivia. Andy Odell, the Co-sysop of The Wild Side,
  380.    deserves a gold medal and a case of Corona for putting up with me while
  381.    I ran his tail all over the house researching questions. Mike Ritter, a
  382.    music lover from way back, came up with some pretty hard questions when
  383.    I needed them most. Well, we didn't want to make it that easy, anyway!
  384.    Thanks, guys! The next round is on me!
  385.  
  386.       Again, I would like to thank Mike Woltz for his support with this
  387.    project. "THE SPITFIRE REVOLUTION" is sweeping the nation! I'm proud to
  388.    be a part of this dynamic group of people!  By the way, Mike is the one
  389.    that wrote the driver for this trivia door.
  390.  
  391.       And last, but certainly not least, I want to thank my wife, Karen,
  392.    and my girls, Kellie and Leslie, for their understanding and patience
  393.    with me while I was glued to the computer.
  394.  
  395.                                                              Michael Peters
  396.